{Core} Top-level tab completion performance improvements #32616
+85
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
DanielMicrosoft
changed the title
DanielMicrosoft
commented
Jan 19, 2026
| import os | ||
| import sys | ||
|
|
||
| if sys.platform == 'win32': |
Contributor
Author
There was a problem hiding this comment.
Emulating skips of incumbent tests, I believe it may be a CI/CD limitation.
DanielMicrosoft
force-pushed
the
36131472-tab-completion-perf
branch
from
c3e4eb1 to
d1a0f27
Compare
DanielMicrosoft
requested review from
calvinhzy,
jsntcy,
kairu-ms and
zhoxing-ms
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a performance optimization for top-level tab completion (i.e., az [TAB]) by avoiding the loading of all command modules. Instead of loading modules to build the full command table, it creates lightweight stub commands using command names from the command index, reducing completion time from over 5 seconds to under 1 second.
Changes:
- Added a new optimization path for top-level completion that creates stub commands without loading modules
- Introduced
TOP_LEVEL_COMPLETION_MARKERconstant to signal the optimization path - Added
_get_top_level_completion_commands()method to retrieve command names from the index - Added
_create_stub_commands_for_completion()method to create lightweight command stubs - Added test coverage for the new top-level completion functionality
- Added VS Code debug configuration for testing tab completion
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| src/azure-cli-core/azure/cli/core/init.py | Core implementation of the tab completion optimization, including stub command creation and command index query logic |
| src/azure-cli-core/azure/cli/core/tests/test_argcomplete.py | Added test case to verify top-level completion returns expected command names |
| .vscode/launch.json | Added debug configuration for testing tab completion in external terminal |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
Description
This PR aims to improve the performance of top-level tab-completion, (i.e.,
az [TAB]).Local testing has shown significant improvements to performance, going from over 5 seconds to under 1 second (Powershell), and from over 1 minute to a couple of seconds on WSL Bash.
Testing conditions:
Testing Guide
Please ensure your terminal is set up for tab-completion.
Test changes with
az [TAB].History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.